ugp.org.SerialX.Protocols

Class AutoProtocol<T>

java.lang.Object

ugp.org.SerialX.Protocols.SerializationProtocol<T>

ugp.org.SerialX.Protocols.AutoProtocol<T>

Type Parameters:

T - | Generic type of object to use protocol for.

public class AutoProtocol<T>
extends SerializationProtocol<T>

This is automatic protocol that will automatically serialize every or selected field in object that has valid and public getter and setter! This protocol is applicable on anything you want however condition of use is absence of final field otherwise createBlankInstance(Class) should be overridden. ALso you should createBlankInstance(Class) when you object is to complex!

Since:

1.2.2

Author:

PETO

Constructor Summary

Constructors

Constructor and Description
AutoProtocol(java.lang.Class<T> applicableFor, java.lang.String... fieldNamesToSerialize)

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends T>	applicableFor()
T	createBlankInstance(java.lang.Class<? extends T> objectClass)
java.lang.Object[]	serialize(T object)
T	unserialize(java.lang.Class<? extends T> objectClass, java.lang.Object... args)

Methods inherited from class ugp.org.SerialX.Protocols.SerializationProtocol

equals, isActive, setActive, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AutoProtocol

public AutoProtocol(java.lang.Class<T> applicableFor,
                    java.lang.String... fieldNamesToSerialize)
             throws java.beans.IntrospectionException

Parameters:

applicableFor - | Class that can be serialized using this protocol.

fieldNamesToSerialize - | Names of fields to serialize, if empty array is put there then all fields with public and valid getters and setters will be serialized!

Throws:

java.beans.IntrospectionException - when there are no field with valid and public getters and setters.

Since:

1.2.2

Method Detail

createBlankInstance

public T createBlankInstance(java.lang.Class<? extends T> objectClass)
                      throws java.lang.Exception

Parameters:

objectClass - | Class to create new instance of!

Returns:

New blank instance of required class! When not override, it returns Serializer#Instantiate(objectClass)

Throws:

java.lang.Exception - if any exception occurs (based on implementation).

Since:

1.2.2

serialize

public java.lang.Object[] serialize(T object)

Specified by:

serialize in class SerializationProtocol<T>

Parameters:

object - | The object.

Returns:

Array of objects to serialize created from given object.

unserialize

public T unserialize(java.lang.Class<? extends T> objectClass,
                     java.lang.Object... args)
              throws java.lang.Exception

Specified by:

unserialize in class SerializationProtocol<T>

Parameters:

objectClass - | The class of object that should be created. This can be useful when object T has children classes with same constructors. You can use reflection to make protocol working also for these child classes!

args - | Args to create obj T from.

Returns:

New instance of object T created from args.

Throws:

java.lang.Exception - you can just pass exception to Serializer if you are not interested in handling it on your own.

applicableFor

public java.lang.Class<? extends T> applicableFor()

Specified by:

applicableFor in class SerializationProtocol<T>

Returns:

Class that can be serialized using this protocol. In other words it should return class of object T